Mention installing Windows VS C++ build tools #1168
Conversation
ChrisDenton
force-pushed
the
windowsbuildtools
branch
from
167bbc2 to
c3bd58f
Compare
|
I think this is a nice addition, I had to do this yesterday and I would go one step further and outline what needs to be installed. Eg:
But I am unsure if this is true for most people? |
|
My main motivation for this PR is to warn of the prerequisite before users start the installation process so that it doesn't come as a surprise. I'm unsure if we need to provide full install instructions here as rustup itself does that. But maybe we do. The rustup installation instructions currently say the following:
This recommends installing the C++ Build Tools workload and adding two components on top of the default selection. |
|
There is a good chance I overlooked it.... I spent around 30 minutes trying to figure this out on stackoverflow/google. On my Mac it took me around 10 seconds :-) |
|
Oh for sure, you're not the only one. The installation story on Windows could be better or at least more automated. I doubt it'll get down to 10 seconds though as Rust does require platform tools (e.g. the linker and import libraries) that aren't available by default and can't be directly bundled (due to licensing, IIRC). |
locales/en-US/tools.ftl
Outdated
| @@ -154,7 +154,7 @@ install-other-methods-link = Learn more | |||
| ## components/tools/rustup.hbs | |||
|
|
|||
| tools-rustup-unixy = It looks like you’re running macOS, Linux, or another Unix-like OS. To download Rustup and install Rust, run the following in your terminal, then follow the on-screen instructions. See <a href="https://forge.rust-lang.org/infra/other-installation-methods.html">"Other Installation Methods"</a> if you are on Windows. | |||
| tools-rustup-windows = It looks like you’re running Windows. To start using Rust, download the installer, then run the program and follow the onscreen instructions. See <a href="https://forge.rust-lang.org/infra/other-installation-methods.html">"Other Installation Methods"</a> if you are not on Windows. | |||
| tools-rustup-windows = It looks like you’re running Windows. To start using Rust, download the installer, then run the program and follow the onscreen instructions. You may need to install the <a href="https://visualstudio.microsoft.com/visual-cpp-build-tools/">Visual Studio C++ Build tools</a> when prompted to do so. If you are not on Windows see <a href="https://forge.rust-lang.org/infra/other-installation-methods.html">"Other Installation Methods"</a>. | |||
There was a problem hiding this comment.
Would you be able to change the key here and in the html to tools-rustup-windows-2? This will help by letting our translators know that this content needs to be updated.
There was a problem hiding this comment.
@XAMPPRocky just for my own interest, how does changing that key allow them to know? Cheers
There was a problem hiding this comment.
@Fasani Sure! We use a localisation service called pontoon https://pontoon.rust-lang.org and changing the key will create a new untranslated key for every other locale. So pontoon will show them they haven’t translated the new text.
There was a problem hiding this comment.
Ok, I think that's fixed now?
Adds a sentence about the C++ build tools being a prerequisite on Windows.
ChrisDenton
force-pushed
the
windowsbuildtools
branch
from
c3bd58f to
f90882f
Compare
|
Thank you again for your PR! |
Adds a sentence about the C++ build tools being a prerequisite on Windows.
Alternatively it could link to the instructions in the book where we could (potentially) give more detailed install instructions. However, I think it's useful to new users to directly present everything they need to get started in Rust.
EDIT: Updated the language used to directly refer to following the prompts in the rustup installer.